<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Google Sitemap Generator: Installation</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link rel="stylesheet" type="text/css" href="http://code.google.com/css/dev_docs.css" />
</head>
<body id="gsg-installation">
<a name="top" id="top"></a>
<!-- ########## PAGE HEADER ########## -->
<div id="header">
  <div id="logo"><a href="http://code.google.com/"><img src="http://code.google.com/images/code_sm.png" border="0" alt="Return to Google Code homepage" /></a></div>
  <h1 id="doc_title">Google Sitemap Generator</h1>
</div>
<!-- ########## END PAGE HEADER ########## -->
<div id="wrapper">
  <!-- ########## SIDE NAVIGATION ########## -->
  <div id="sidenav">
    <ul>
      <li id="gsg_intro_link"><a href="gsg-intro.html">Introduction</a></li>
      <li id="gsg_installation_link"><a href="gsg-installation.html" id="gsg_installation">Installation</a></li>
      <li id="gsg_configuration_link"><a href="gsg-configuration.html">Configuration</a></li>
      <li id="gsg_reference_link"><a href="gsg-reference.html">Reference</a></li>
    </ul>
  </div>
</div>
<!-- ########## END SIDE NAVIGATION ########## -->
<!-- ########## PAGE CONTENT ########## -->
<div id="pagecontent">
  <h1 id="page_title">Installation </h1>
  <p>This document explains how to install and uninstall Google Sitemap Generator. </p>
  <p>In this document: </p>
  <ol class="toc">
    <li><a href="#gsg_i_wininstall">Windows Installation</a>
    <li>
      <ol class="toc">
        <li><a href="#gsg_i_winprereq">Prerequisites</a></li>
        <li><a href="#gsg_i_wininstallproc">Installation steps</a></li>
        <li><a href="#gsg_i_winresults">Results of the installation</a></li>
        <li><a href="#gsg_i_winuninstall">Uninstallation steps</a></li>
      </ol>
    </li>
    </li>
    <li><a href="#gsg_i_lin">Linux Installation</a></li>
    <li>
      <ol class="toc">
        <li><a href="#gsg_i_linprereq">Prerequisites</a></a></li>
        <li><a href="#gsg_i_lininstallproc">Installation steps</a></a></li>
        <li><a href="#gsg_i_linresults">Results of the installation</a></li>
        <li><a href="#gsg_i_linuninstall">Uninstallation steps</a></li>
      </ol>
    </li>
    </li>
  </ol>
  <h2><a name="gsg_i_wininstall" id="gsg_i_wininstall"> </a> Windows Installation </h2>
  <p>This section provides installation instructions for Windows platforms. </p>
  <h3> <a name="gsg_i_winprereq" id="gsg_i_winprereq"><br />
    </a>Prerequisites </h3>
  <p>These are the prerequisites for installation: </p>
  <ul>
    <li><strong>System and web server</strong>. 
      Google Sitemap Generator has been tested on the following platforms:
      <ul>
        <li>Microsoft Windows  2003 Server  (32 bit or 64 bit) with  Internet Information Service (IIS) 6.0 </li>
        <li>Microsoft Windows  2008 Server (32 bit or 64 bit) with  IIS 7.0 </li>
      </ul>
    </li>
    <li><strong>Free disk space</strong>.  You'll need between 100MB and 1GB of free disk space; the number of unique URLs on <br />
      your website determines the actual disk space needed. One million URLs require 
      approximately 1GB of disk space. </li>
    <li><strong>Web server access</strong>. You'll need administrative access to the web server, through a console or remote desktop. </li>
  </ul>
  <h3><a name="gsg_i_wininstallproc" id="gsg_i_wininstallproc"><br />
    </a>Installation Process </h3>
  <p>Installation of  Google Sitemap Generator restarts the World Wide Web Publishing service. Be sure to perform the installation at a time when the restart won't cause a problem. </p>
  <p>Follow these steps to install Google Sitemap Generator: </p>
  <ol>
    <li>From <a href="http://code.google.com/p/googlesitemapgenerator/downloads/list" target="_blank"> http://code.google.com/p/googlesitemapgenerator/downloads/list </a>, download the latest version of the msi file.</li>
    <li>Run the file to launch the setup program.
      <p class="note"><strong>Note:</strong> If you've previously installed Google Sitemap Generator, or if you've started the installation and not completed it, the installer asks whether you want to repair the software or remove it. Select <strong>Remove Google Sitemap Generator (Beta)</strong> and then click <strong>Finish</strong> to start the  uninstallation program. When uninstallation is complete, you can restart the installation.</p>
    </li>
    <li>When the License Agreement appears, read and accept the Terms of Service. If you do not accept the Terms of Service,  click <strong>Cancel</strong> to exit the installation.
      <p>The Privacy Warning now appears. </p>
    </li>
    <li>Read the Privacy Warning, which contains important information. Click <strong>Next</strong> to continue.
      <p >The <strong>Automatic Sitemap submission </strong> panel now asks whether you want Google Sitemap Generator to start up with automatic submission of Web Sitemaps enabled. When the software starts running, automatic submission is disabled by default.</p>
      <ul>
        <li>To defer submission of submitting Sitemaps, you can accept the default value. In the Admin Console, you'll be able to configure and test Sitemaps before submitting them.</li>
        <li>To start automatic submission now, you can choose <strong>First installation. Start with automatic submission enabled.</strong></li>
        <li>If you are reinstalling, you have an additional option, <strong>Use the old automatic submission settings</strong>. This option reinstates the settings that were in effect when you uninstalled and enables you to retain per-site configurations. </li>
      </ul>
      <p> If you accidentally choose one of the first two options during a reinstall, the specified configuration applies, but your old configuration file will be lost. If you accidentally choose the last option during your first install, the default value of starting with automatic submission disabled applies. </p>
    </li>
    <li >Make your choice and then click <strong>Next</strong>.
      <p>Because IIS must restart before Google Sitemap Generator takes effect, you're now asked about the IIS restart. </p>
    </li>
    <li> Specify whether you want to let the installation program restart IIS automatically after installation is complete, or  to restart IIS manually.
      <p>The <strong>Select Installation Folder</strong> page appears, showing a default folder and letting you choose a different folder. </p>
    </li>
    <li>When you're done, click <strong>Next</strong>. </li>
    <li>When the <strong>Confirm Installation</strong> page  asks you to confirm the installation, click <strong>Next</strong> to install.
      <p>A progress bar appears while  Google Sitemap Generator  installs its Windows  service and IIS filter and then restarts the World Wide Web Publishing service. Several windows may open and close during this time. </p>
    </li>
    <li>When a command window opens and waits for you to &quot;Enter new password,&quot; provide a password for the Admin Console.
      <p>Command windows now display the startup of various components. When all startup is complete, a browser opens, to the address http://<em>your-address</em>:8181. The <strong>Installation Complete</strong> page of the installer program might be behind your browser. </p>
    </li>
    <li>On the <strong>Installation Complete</strong> page, click <strong>Close</strong> to exit. </li>
  </ol>
  <p>Now you're ready to configure Google Sitemap Generator, which has already  detected your websites. View the <a href="gsg-configuration.html">configuration document</a> for more information about how to configure the settings for your websites. </p>
  <h3><a name="gsg_i_winresults" id="gsg_i_winresults"><br />
    </a>Results of the Installation </h3>
  <p>Installation of Google Sitemap Generator has the following effects on your system:</p>
  <ul>
    <li> The program files reside in the folder specified during installation. The default folder is C:\Program Files\Google\Google Sitemap Generator. </li>
    <li>A Windows service named Google Sitemap Generator is installed. </li>
    <li>An IIS module or filter  is installed at the global level and applied to all sites.
      <ul>
        <li>For IIS 6.0, the ISAPI filter  GoogleSitemapGeneratorFilter is  installed.</li>
        <li>For IIS 7.0, the IIS module GoogleSitemapGeneratorModule  is installed. </li>
      </ul>
    </li>
  </ul>
  <h3><a name="gsg_i_winuninstall" id="gsg_i_winuninstall"><br />
    </a>Uninstallation Steps </h3>
  <ol>
    <li>From the Windows Control Panel's <strong>Add or Remove Programs</strong> window, find <strong>Google Sitemap Generator</strong> and click Remove.
      <p> Google Sitemap Generator  is then ready to uninstall its Windows  service and IIS filter, and to restart the World Wide Web Publishing service. </p>
    </li>
    <li>When you are prompted &quot;Are you sure you want to remove Google Sitemap Generator...,&quot; click <strong>Yes</strong>.  A progress bar appears to display the progress of the uninstallation. </li>
    <li>When the &quot;Installation Complete&quot; message appears, click <strong>Close</strong> to remove the message. If you plan to reinstall Google Sitemap Generator in the future, you're done!</li>
    <li>If you don't plan to reinstall Google Sitemap Generator in the future, you can manually remove the historical data and the configuration file. These files are in website-specific directories  under  C:\Program Files\Google\Google Sitemap Generator, unless you  specified an alternative path during installation. </li>
  </ol>
  <p class="backtotop"><a href="#top">Back to top</a></p>
  <h2><a name="gsg_i_lin" id="gsg_i_lin"></a>Linux Installation</h2>
  <p>This section provides installation instructions for Linux platforms. </p>
  <h3><a name="gsg_i_linprereq" id="gsg_i_linprereq"><br />
    </a>Prerequisites</h3>
  <p>These are the prerequisites for installation: </p>
  <ul>
    <li><strong>Operating system</strong>. Google Sitemap Generator has been tested with the following types of Linux systems:
      <ul>
        <li>CentOS 4.6 </li>
        <li>Fedora 7 </li>
        <li>Debian etch r0 </li>
        <li>Mandriva 2007 </li>
        <li>Red Hat Enterprise  Linux 3 (32 bit or 64 bit) </li>
        <li>Red Hat Enterprise  Linux 4 (32 bit or 64 bit) </li>
        <li>SUSE Linux Enterprise  Server 10.0 (32 bit or 64 bit) </li>
        <li>Ubuntu 6.10  (32 bit or 64 bit) </li>
      </ul>
    </li>
    <li><strong>Web server</strong>. Google Sitemap Generator has been tested with Apache  web server versions 1.3, 2.0, and 2.2. </li>
    <li><strong>Disk space</strong>. You'll need between 100MB and 1GB of free disk space; the number of unique URLs on <br />
      your website determines the actual disk space needed. One million URLs require approximately 1GB of disk space. </li>
    <li><strong>Web server access</strong>. You'll need administrative access to the web server. </li>
     
    </li>
  </ul>
  <h3><a name="gsg_i_lininstallproc" id="gsg_i_lininstallproc"></a><br />
    Installation Process </h3>
  <p>Follow these steps to install Google Sitemap Generator: </p>
  <ol class="input">
    <li>From <a href="http://code.google.com/p/googlesitemapgenerator/downloads/list" target="_blank"> http://code.google.com/p/googlesitemapgenerator/downloads/list</a>,  download the installation package that matches your Linux version and Apache version. </li>
    <li><strong> </strong>Using the root account, extract the install package:
      <p><code>tar –zxvf <em>filename</em> </code></p>
      <p>In this format, <em>filename</em> is the name of the version-specific installation package you downloaded.</p>
    </li>
    <li> Run the install  script, using the  following command format:
      <p><code>sitemap-install/install.sh </code>[<em>option</em>]...</p>
      <p>In this format, <em>option</em> is one of the following:</p>
      <ul>
        <li> <code>-h</code> displays help about these  command line options. </li>
        <li> <code>-d</code> <em>directory</em> specifies  a non-default installation directory. </li>
        <li> <code>-a</code> <em>Apache-binary-filename</em> specifies the path to the Apache binary file  (httpd). Alternatively, you can specify this value during installation. </li>
        <li> <code>-c</code> <em>Apache-config-filename</em> specifies the Apache root configuration file.</li>
        <li> <code>-g</code> <em>Apache-group</em> specifies the user group name under which Apache is running. </li>
        <li> <code>-t</code> <em>Apache-control-filename</em> specifies the Apache control script  (apache ctl). If you specify this value, the installer lets you choose to automatically restart Apache at the end of the installation. If you omit this option, you'll need to restart Apache manually. </li>
      </ul>
      <p> All of these  parameters are optional. Use a space to separate multiple options.</p>
      <p>Example: <code>sitemap-install/install.sh -t /usr/sbin/apache2ctl -g www-data </code></p>
      <p>The script responds in one of the following ways: </p>
      <ul>
        <li>Continues  with the installation. </li>
        <li>Informs you that  a previous version exists,  and asks whether you want to uninstall. If you answer Y (yes), the installation script stops and runs the uninstallation script. When uninstallation completes, you can restart the installation. </li>
        <li>Informs you that files remain from a  previous installation, and asks whether you want to overwrite them. This message appears even if you previously started an installation that did not complete. Overwriting these files does not harm any database files or configuration files that were previously created and saved at uninstallation. </li>
      </ul>
      <p>The installation now starts and displays the privacy policy. </p>
      <pre>********************************************************************* 
Welcome to Google Sitemap Generator (Beta) 
For more information, please visit: 
http://code.google.com/p/googlesitemapgenerator/ 
******************************************************************** 
Any Sitemap information that you send to Google, including Sitemaps... </pre>
    </li>
    <li>Read the privacy warning, which contains important information. </li>
    <li>Press Enter to continue. The Terms of Service appear. Note their location, in case you need to read them again. </li>
    <li>Read the Terms of Service.
      <pre>Do you agree with the Terms of Service? [N/y]y </pre>
    </li>
    <li>Enter y (yes) if you agree with these terms. If you press Enter to take the default response or answer N (no), the installation script exits.
      <p>The installer now displays the default installation directory, or the non-default value that you specified on the installation command line. </p>
      <pre>Google Sitemap Generator will be installed into /usr/local/google-sitemap-generator</pre>
    </li>
    <p>If the directory is not empty, the install script asks whether you want to overwrite the old files in the  directory. If you agree to overwrite the files, you don't  lose the old configuration file and database that you'd previously saved during the previous uninstallation. </p>
    <p>If you did not use the <code>-a</code> or <code>-t</code> option to start the installation script, it now asks for the location of the Apache binary file (httpd) or control script (apache ctl), so that it can find the configuration file and get information about your Apache installation. </p>
    <pre>This installation updates the Apache configuration file. To find that file, 
the installer needs the location of the Apache binary (httpd) or control 
script (apachectl). The binary or control script that you specify must 
support the -V option.  


What is the location of the Apache binary or control script? [/usr/sbin/apache2]  </pre>
    </li>
    <li>If this message appears, accept the displayed value   or specify a different binary  or control script.
      <p>The installation script now displays information about your Apache configuration and asks whether it is correct. </p>
      <pre> *********************************************************************
      The following information about your Apache installation has been detected:
      * Apache version: 2.0
      * Apache architecture: 32 bits
      * Apache root configuration file: /etc/apache2/apache2.conf
      * Apache pid file: /var/run/apache2.pid
      * Apache group: www
*********************************************************************
Is all of this information correct?
If you answer No, installation will terminate and you'll need to restart the 
installation, using the necessary command-line options. [N/y] </pre>
    </li>
    <li>Examine the information carefully, and then do one of the following:
      <ul>
        <li> Answer y (Yes) if the script found the correct binary or control script, and if all the other information is correct. </li>
        <li>Accept the default response or answer N (No) if the binary or control script is incorrect and you want to correct it.  If you see any questionable information, such as an environment variable instead of a value, answer no (N) to cancel the installation. When you restart the installation, provide  the necessary information on the command line.
          <p> If everything is fine, some lines like this appear. </p>
          <pre>Google Sitemap Generator will start creating Web Sitemap files as soon as it
starts up. Do you want Google Sitemap Generator to start submitting these
files automatically? There are three options:

1.  First installation. Start with automatic submission disabled.
2.  First installation. Start with automatic submission enabled.
3.  Reinstallation. Use the old automatic submission settings.

Specify your choice [1]:2</pre>
        </li>
      </ul>
      <p>If you are installing Google Sitemap Generator for the first time, you can start it  with automatic submission disabled or enabled. By default, it starts  with automatic submission disabled, providing time for configuration and testing before  Sitemap files are submitted to search engines. This setting applies to all websites on the web server. </p>
      <p>If you are reinstalling Google Sitemap Generator: </p>
      <ul>
        <li> You can reuse the  site-specific   
          automatic submission settings that were in effect when you uninstalled. If only some sites were configured for automatic Web Sitemap submission, only those sites are enabled at startup. Automatic Web Sitemap submission is specified under <strong>Sitemap file submission</strong> and controlled by the  robots.txt option and the search engine ping URLs.</li>
        <li>You can start all sites on the web server with automatic submission disabled (option 1) or enabled (option 2). However, those options also set all your other  configuration settings to their default values. </li>
      </ul>
    </li>
    <li>Specify the option for automatic Web Sitemap submission.
      <p> You'll now see status messages showing progress. </p>
      <pre>Program files successfully copied.
Google Sitemap Generator settings successfully updated.
Google Sitemap Generator init scripts successfully installed.
Apache configuration successfully updated.
Old configuration is saved at /etc/google-sitemap-generator/httpd.install.conf
Ready to set the password for the administration console.
Enter new password (5 or more characters):</pre>
    </li>
    </ul>
    </li>
    <li>Enter a  password and then confirm the password.
      <pre>
Google Sitemap Generator daemon successfully started.</pre>
      <p>If you specified the <code>-t</code> option on the command line, the script now asks whether you want to restart Apache.</p>
      <pre>To start the Google Sitemap Generator module in Apache, you must restart Apache. 
Do you want to restart Apache now? [N/y]</pre>
    </li>
    <li>Accept the default response, N (No) to defer the Apache restart, or answer y (Yes) to restart Apache now.
      <p> If you answer N, the following message appears:</p>
      <pre>Google Sitemap Generator (Beta) is installed successfully. 
After you restart Apache, you can go to http://&lt;this-server-address&gt;:8181/ to configure the application.</pre>
      <p>If you answer Y, the following message appears:</p>
      <pre>
Google Sitemap Generator (Beta) was successfully installed. 
Apache was successfully restarted.
You can now go to http://&lt;this-server-address&gt;:8181/ to start configuration.</pre>
    </li>
    </li>
  </ol>
  <p >You're now done and ready to configure Google Sitemap Generator. View the <a href="gsg-configuration.html">configuration document</a> for more information about how to configure the settings for your websites. </p>
  <h3><a name="gsg_i_linresults" id="gsg_i_linresults"></a><br />
    Results of the Installation </h3>
  <p>This section describes the changes that the installation makes to your system. The section covers: </p>
  <ul>
    <li><a href="#gsg_i_linfiles">Files installed</a></li>
    <li><a href="#gsg_i_linapache">Changes to the Apache configuration file</a></li>
    <li><a href="#gsg_i_linctl">The control script </a></li>
  </ul>
  <h4><a name="gsg_i_linfiles" id="gsg_i_linfiles"></a><br />
    Files installed </h4>
  <p>Installation of Google Sitemap Generator creates the files listed in the following table. </p>
  <table width="95%" border="1" summary="This table lists the files created by installation. The left column contains the file name and the right column contains the description.
">
    <tr>
      <th scope="col">File</th>
      <th scope="col">Description</th>
    </tr>
    <tr>
      <td><code>/usr/local/google-sitemap-generator</code></td>
      <td>Path to the program files, settings, and so on </td>
    </tr>
    <tr>
      <td><code>/etc/google-sitemap-generator</code></td>
      <td>Global registry information about Google Sitemap Generator </td>
    </tr>
    <tr>
      <td><code>/etc/init.d </code></td>
      <td>Contains scripts for starting Google Sitemap Generator.</td>
    </tr>
  </table>
  <h4><a name="gsg_i_linapache" id="gsg_i_linapache"></a><br />
    Changes to the Apache configuration file </h4>
  <p> During installation, the  installation script first backs up the Apache configuration file and then modifies the configuration file. The installation script does the following: </p>
  <ul>
    <li>Backs  up the configuration file to this location: <code>/etc/google-sitemap-generator/httpd.install.conf</code></li>
    <li>Adds the following line to enable Apache to load the Sitemap module and to create a virtual host for admin console.
      <pre>Include /usr/local/google-sitemap-generator/conf/httpd.conf </pre>
    </li>
  </ul>
  <p> If you uninstall Google Sitemap Generator, the uninstallation script removes the Include line from the configuration file.</p>
  <h4><a name="gsg_i_linctl" id="gsg_i_linctl"></a><br />
    The control script </h4>
  <p>Once installation is complete,  Google Sitemap Generator service  automatically starts when the system starts. When the system is running, you can control  the Google Sitemap Generator service by running this script, for which you'll need root privileges: </p>
  <p><code>/usr/sbin/google-sitemap-generator-ctl</code></p>
  <p>You must have root privileges in order to run the script. </p>
  <p>Use the following command to control the Google Sitemap Generator service: </p>
  <p ><code>sudo google-sitemap-generator-ctl service start | stop | restart </code> </p>
  <p> Note that this  script  controls the Google Sitemap Generator service, but it does not control the Sitemap  filter in Apache. To control the filter, you'll need to use the Apache controller. </p>
  <h3><a name="gsg_i_linuninstall" id="gsg_i_linuninstall"></a><br />
    Uninstallation Steps </h3>
  <p>Before starting, note that the Apache server must be stopped in order for uninstallation to occur. If the Apache server is running, you will be asked to stop it. </p>
  <p>To uninstall Google Sitemap Generator, use the root account to run the uninstall script, as follows: </p>
  <p> <code> /usr/local/google-sitemap-generator/uninstall.sh</code></p>
  <p>The last lines of the uninstallation script  are as follows:</p>
    
  <pre>The URL database and application settings file can be saved and used when 
you reinstall. If you choose to save the files now, but later you want to 
remove them, you can run this script again.&quot;
&quot;Do you want to save the URL database and application settings file ? [Y/n]&quot;</pre>
  
  <p>Respond as follows: </p>
  <ul>
    <li>Respond Y (yes) if you won't be reinstalling Google Sitemap Generator. </li>
    <li>Respond n (no) if you might want to re-use the generated data and configuration file. </li>
  </ul>
  <p class="backtotop"><a href="#top">Back to to</a></p>
</div>
<p id="date"> Updated on
  <!-- javascript to display the date this page was updated -->
  <script type="text/javascript">
<!-- hide script from old browsers
    var lm = new Date(document.lastModified);
    document.write(lm.toDateString());
//-->
</script>
  <!-- end javascript -->
</p>
</body>
</html>
